{-
	Copyright (c) 2009 Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	All rights reserved
	Licensed under GNU LGPL v2.1

	$Id: SwissClassicDeck.hs 15 2009-09-28 21:16:23Z aitorlf $

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU Lesser General Public
	License version 2.1 (and just under that one) as published by
	the Free Software Foundation.

	This program is distributed in the hope that it will be useful,
	but without any warranty; without even the implied warranty of
	merchantability or fitness for a particular purpose. See the GNU
	Lesser General Public License for more details.

	You should have received a copy of the GNU Lesser General Public
	License along with this program; if not, write to the Free
	Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
	MA 02111-1307, USA.
-}

{-|
	Module		: Games.Cards.Deck.SwissClassicDeck
	Copyright	: (c) Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	License		: GNU LGPL v2.1 <http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html>

	Maintainer	: Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	Stability	: provisional
	Portability	: portable

	Definition of the Swiss classic (48 cards) deck according to Games.Cards.Deck.

	This module defines the basic Swiss 48 cards classic deck.
-}
module Games.Cards.Deck.SwissClassicDeck(
		-- * Swiss 48 cards classic deck
		-- ** Types defining cards and decks for the Swiss classic deck
		SwissClassicRank(..),
		SwissSuit(..),
		SwissClassicCard,
		SwissClassicDeck,
		-- ** Instances of Swiss classic decks
		swissClassicDeck,
	)where

import Games.Cards.Deck


-- | Well-known ranks for the classic Swiss deck.
data SwissClassicRank =
		-- | 'Two' (/2/)
		Two
		-- | 'Three' (/3/)
		| Three
		-- | 'Four' (/4/)
		| Four
		-- | 'Five' (/5/)
		| Five
		-- | 'Six' (/6/)
		| Six
		-- | 'Seven' (/7/)
		| Seven
		-- | 'Eight' (/8/)
		| Eight
		-- | 'Nine' (/9/)
		| Nine
		-- | 'Banner' (/10/)
		| Banner
		-- | 'Under' (/Lower Jack/)
		| Under
		-- | 'Ober' (/Upper Jack/)
		| Ober
		-- | 'Konig' (/King/)
		| Konig
	deriving (Eq, Ord, Enum, Bounded, Show, Read)
instance CardRank SwissClassicRank


-- | Well-known suits for the Swiss deck.
data SwissSuit =
		-- | 'Eicheln' (/Acorns/)
		Eicheln
		-- | 'Schilten' (/Shields/)
		| Schilten
		-- | 'Rosen' (/Roses/)
		| Rosen
		-- | 'Schellen' (/Bells/)
		| Schellen
	deriving (Eq, Enum, Bounded, Show, Read)
instance CardSuit SwissSuit


-- | Definition of the 48 cards classic Swiss @'Card'@s and @'Deck'@s.

-- | Swiss classic card type.
type SwissClassicCard = Card SwissClassicRank SwissSuit WildCardNone

-- | Swiss classic deck type.
type SwissClassicDeck = Deck SwissClassicRank SwissSuit WildCardNone

-- | Swiss classic deck instance.
swissClassicDeck :: SwissClassicDeck
swissClassicDeck = deck
